<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="UTF-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
	<title>Remote cluster info API | ElasticSearch 7.7 权威指南中文版</title>
	<meta name="keywords" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <meta name="description" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <!-- Give IE8 a fighting chance -->
    <!--[if lt IE 9]>
    <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
    <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
    <![endif]-->
	<link rel="stylesheet" type="text/css" href="../static/styles.css" />
	<script>
	var _link = 'cluster-remote-info.html';
    </script>
</head>
<body>
<div class="main-container">
    <section id="content">
        <div class="content-wrapper">
            <section id="guide" lang="zh_cn">
                <div class="container">
                    <div class="row">
                        <div class="col-xs-12 col-sm-8 col-md-8 guide-section">
                            <div style="color:gray; word-break: break-all; font-size:12px;">原英文版地址: <a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cluster-remote-info.html" rel="nofollow" target="_blank">https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cluster-remote-info.html</a>, 原文档版权归 www.elastic.co 所有<br/>本地英文版地址: <a href="../en/cluster-remote-info.html" rel="nofollow" target="_blank">../en/cluster-remote-info.html</a></div>
                        <!-- start body -->
                  <div class="page_header">
<strong>重要</strong>: 此版本不会发布额外的bug修复或文档更新。最新信息请参考 <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html" rel="nofollow">当前版本文档</a>。
</div>
<div id="content">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="index.html">Elasticsearch Guide [7.7]</a></span>
»
<span class="breadcrumb-link"><a href="rest-apis.html">REST APIs</a></span>
»
<span class="breadcrumb-link"><a href="cluster.html">Cluster APIs</a></span>
»
<span class="breadcrumb-node">Remote cluster info API</span>
</div>
<div class="navheader">
<span class="prev">
<a href="cluster-pending.html">« Pending cluster tasks API</a>
</span>
<span class="next">
<a href="tasks.html">Task management API »</a>
</span>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h2 class="title">
<a id="cluster-remote-info"></a>Remote cluster info API<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cluster/remote-info.asciidoc">edit</a>
</h2>
</div></div></div>

<p>Returns configured remote cluster information.</p>
<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="cluster-remote-info-api-request"></a>Request<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cluster/remote-info.asciidoc">edit</a>
</h3>
</div></div></div>
<p><code class="literal">GET /_remote/info</code></p>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="cluster-remote-info-api-desc"></a>Description<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cluster/remote-info.asciidoc">edit</a>
</h3>
</div></div></div>
<p>The cluster remote info API allows you to retrieve all of the configured
remote cluster information. It returns connection and endpoint information keyed
by the configured remote cluster alias.</p>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="cluster-remote-info-api-response-body"></a>Response body<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cluster/remote-info.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">mode</code>
</span>
</dt>
<dd>
Connection mode for the remote cluster. Returned values are <code class="literal">sniff</code> and
<code class="literal">proxy</code>.
</dd>
<dt>
<span class="term">
<code class="literal">connected</code>
</span>
</dt>
<dd>
True if there is at least one connection to the remote cluster.
</dd>
<dt>
<span class="term">
<code class="literal">initial_connect_timeout</code>
</span>
</dt>
<dd>
The initial connect timeout for remote cluster connections.
</dd>
</dl>
</div>
<div class="variablelist">
<a id="skip-unavailable"></a>
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">skip_unavailable</code>
</span>
</dt>
<dd>
Whether the remote cluster is skipped in case it is searched through
a cross-cluster search request but none of its nodes are available.
</dd>
<dt>
<span class="term">
<code class="literal">seeds</code>
</span>
</dt>
<dd>
Initial seed transport addresses of the remote cluster when sniff mode is
configured.
</dd>
<dt>
<span class="term">
<code class="literal">num_nodes_connected</code>
</span>
</dt>
<dd>
Number of connected nodes in the remote cluster when sniff mode is
configured.
</dd>
<dt>
<span class="term">
<code class="literal">max_connections_per_cluster</code>
</span>
</dt>
<dd>
Maximum number of connections maintained for the remote cluster when sniff
mode is configured.
</dd>
<dt>
<span class="term">
<code class="literal">proxy_address</code>
</span>
</dt>
<dd>
Address for remote connections when proxy mode is configured.
</dd>
<dt>
<span class="term">
<code class="literal">num_proxy_sockets_connected</code>
</span>
</dt>
<dd>
Number of open socket connections to the remote cluster when proxy mode
is configured.
</dd>
<dt>
<span class="term">
<code class="literal">max_proxy_socket_connections</code>
</span>
</dt>
<dd>
The maximum number of socket connections to the remote cluster when proxy
mode is configured.
</dd>
</dl>
</div>
</div>

</div>
<div class="navfooter">
<span class="prev">
<a href="cluster-pending.html">« Pending cluster tasks API</a>
</span>
<span class="next">
<a href="tasks.html">Task management API »</a>
</span>
</div>
</div>

                  <!-- end body -->
                        </div>
                        <div class="col-xs-12 col-sm-4 col-md-4" id="right_col">
                        
                        </div>
                    </div>
                </div>
            </section>
        </div>
    </section>
</div>
<script src="../static/cn.js"></script>
</body>
</html>